﻿namespace Dhgms.Whipstaff.Core.Model
{
    /// <summary>
    /// Enumeration to indicate the state of a validation process.
    /// </summary>
    public enum ValidationIndicator
    {
        /// <summary>
        /// Status is unknown
        /// </summary>
        Unknown,

        /// <summary>
        /// The input is optional, but has not yet populated to a state that fires off any validation.
        /// </summary>
        Optional,

        /// <summary>
        /// The input is required, but has not yet populated to a state that fires off any validation.
        /// </summary>
        Required,

        /// <summary>
        /// The input is invalid and needs some form of correction.
        /// </summary>
        Error,

        /// <summary>
        /// The input has a warning so might need checking to ensure it is actually valid.
        /// </summary>
        Warning,

        /// <summary>
        /// The input is fine.
        /// </summary>
        Ok,

        /// <summary>
        /// Validation of the input is currently taking place.
        /// </summary>
        InProgress
    }
}
